Licensing an Adapter

License each TA adapter separately. You cannot use an adapter until you apply the license file. If you purchase the adapter after installing TA, you will receive a new license file authorizing the use of the adapter.

You might have a demo license which is good for 30 days, or you might have a permanent license. The procedures to install these license files are described below.

To install an adapter license on a Windows-based TA Master:

  1. Stop the TA Master:

    1. Click Start and choose All Programs > Tidal Workload Automation > Scheduler > Service Control Manager.

    2. Verify that the TA Master is displayed in the Service list and choose Stop to halt the TA Master.

  2. Create the license file:

    For a permanent license, rename your Permanent license file to master.lic.

    For a demo license, create a file called demo.lic, then type the demo code into the demo.lic file.

  1. Place the file in the C:\Program Files\TIDAL\Scheduler\Master\config directory.

  2. Click Start in the Service Control Manager to restart the TA Master. The TA Master reads and applies the license when it starts.

  3. Choose Registered License from the Activities main menu to validate that the license was applied.

To install an adapter license on a UNIX-based TA Master:

  1. Stop the TA Master:

    From the command line, enter tesm stop

  2. Create the license file:

    For a Permanent license, rename your Permanent license file to master.lic.

    For a Demo license, create a file called demo.lic, then type the demo code into the demo.lic file.

  1. Place the file in the config directory.

  2. Restart the TA Master by entering tesm start on the command line. The TA Master will read and apply the license when it starts.

  3. Choose Registered License from the Activities main menu to validate that the license was applied.

Configuring the HTTPS Protocol

Note: Tidal recommends that Web servers be configured to use SSL via the HTTPS protocol for Data Services/Data Integrator. If your environment is configured to use HTTP, skip this section.

Obtaining Security Certificates

From a Windows desktop, obtain a security certificate for each target Web Service server by accessing your web browser’s certificate cache.

For illustrative purposes, this section shows how to obtain the security certificates from Internet Explorer.

Note: Although other procedures are available for obtaining the required certificates, the procedure below can be performed from your Windows desktop.

Note: Follow the instructions below only if your server certificate is generated in-house (that is, self-signed) or if your server certificate is signed by a Certification Authority that is not trusted by the version of Java you are using. Alternatively, if your adapter connection fails by reporting the error “unable to find valid certification path to requested target”, implement these instructions.

To obtain target Web Service server security certificates:

  1. Open the Internet Explorer browser and navigate to the dispatch URL (replacing servername and port as it applies to your environment).

    Example: https://<adminHost:adminPort>/admin/servlet/webservices
    where adminHost is where the Data Integrator Administrator is installed and adminPort is the port the Data Integrator Administrator is listening on.

  1. Click View Certificate to open the Certificate dialog.

  2. Click Install Certificate.

  3. Click Next on the Certificate Import Wizard Welcome panel.

  4. Use the default option Automatically on the Certificate Store panel and choose the certificate store based on the type of certificate and click Next.

  5. Click Finish on the Completing Certificate Import Wizard panel.

    Note: If a Security Warning message is displayed with a message that the certificate you are installing is from a certification authority, click Yes to continue with the certificate installation.

  6. Click OK to close the message and return to the Certificate dialog.

  7. Click OK on the Certificate dialog. You can close the browser.

    Repeat the process for each Web server that you want to connect to with the Adapter.

Exporting Security Certificates

After you have obtained security certificates for the target servers, export them from the browser cache to a local directory. Different browsers use different procedures for exporting security certificates. You should follow the process defined by the browser you are using to export these certificates as DER-encoded binary X.509 (.CER) security certificates to:

Example: C:\WebServer-Certs\<servername>.cer

For illustrative purposes, this section shows how to export the security certificates from Internet Explorer.

To export the cached certificates from Internet Explorer to a local directory:

  1. Create the directory for the certificates on the local computer:

    Example: C:\WebServer-Certs

  2. Click Tools > Internet Options in Internet Explorer.

  3. Click the Content tab in the Internet Options dialog.

  4. Click Certificates in the Certificates area.

  5. Click the Certificates dialog and choose the Trusted Root Certification Authorities tab to display the list of trusted certificates. This list should contain the certificates for the target servers that were obtained in the previous procedure. See Obtaining security certificates.

  6. Scroll through the list to find the certificates.

  7. Perform this procedure for each target server certificate:

    1. Choose the certificate and click Export to launch the Certificate Export Wizard.

    2. Click Next in the Welcome panel.

    3. Click the Export File Format panel and use the default option DER encoded binary X.509 (.CER) and click Next.

    4. Click the File To Export panel and enter the complete path to the WebServer-Certs directory and a unique name for the certificate:

      Example: C:\WebServer-Certs\<servername>.cer

    5. Click Next.

    6. Click Finish on the Completing the Certificate Export Wizard panel to complete the export.

    7. Click OK.

  1. Click Close after all target server certificates have been exported to exit the Certificates dialog.

  2. Click OK to close the Internet Options dialog.

Importing Target Server Certificates into a Java Keystore

Note: These instructions assume that a JRE or JDK is in your system PATH.

To import certificates into a Java keystore:

  1. Open a Windows Command Prompt window.

  2. Change to the directory where the certificates are stored by entering these commands:

    Example: C: cd \WebServer-Certs

  3. Use the Java keytool utility to import a certificate. This syntax is used:

    Example: keytool -import -file <certificate-filename> -alias <server-name> -keystore WebServer.keystore

    Example: C:\WebServer-Certs>keytool -import -file sdkpubs01.crt -alias sdkpubs01 -keystore WebServer.keystore

  4. Enter a password at the prompt when prompted to create a password for the keystore. The keystore utility displays the certificate information.

  5. Type yes at the Trust this certificate? [no] prompt and click Enter. The certificate is imported into the WebServer.keystore keystore and this message displays:

    Example: Certificate was added to keystore

  6. Repeat this procedure for each target server.

  7. Navigate to this folder where the Adapter is installed and create a new directory named config:

    Example: <install dir>\master\services\\{53F9019F-8B82-4BA0-BB29-178BE42D0564}\config

  8. Create a text file named service.props, if it doesn’t already exist.

  9. Open the service.props text file and add the this line:

    Example: Keystore=c:\\WebServer-Certs\\WebServer.keystore (Note the use of escaped backslashes for Windows directories.)

    See Configuring service.props for information about general and adapter-specific properties that can be set to control things like logging and connection properties.

    Note: This feature is effective only if the Master is running and you have configured HTTPS protocol by specifying the Keystore property in Adapter's service.props file.